SettingsEcom Class Reference

List of all members.

Public Member Functions

SettingsEcom ($courseid)

addError ($errorString)

resetErrors ()

getDBSettings ()

setName ($name)

setShortname ($shortname)

setModulShortCut ($modulShortCut)

setStyle ($style)

setKeywords ($keywords)

setFAQURL ($faq)

setSemester ($semester)

setOpendate ($opendate)

setClosedate ($closedate)

setRegpass ($regpass)

setMaxStudents ($count)

setUseWaitinglist ($use)

setInfo ($info)

getID ()

getName ()

getShortname ()

getModulShortCut ()

getKeywords ()

getSemester ()

getOpendate ()

getClosedate ()

getRegpass ()

getUseWaitinglist ()

getMaxStudents ()

getInfo ()

getClosed ()

getStyle ()

getFAQ ()

registrationIsActive ()

validateMaxStudents ($maxStudents)

Static Public Member Functions

validateName ($name)

validateShortname ($shortname)

validateKeywords ($keywords)

formatName ($name)

validateRegistrationPassword ($pass)

validateInfo ($info)

formatInfo ($info)

validateStyle ($style)

echoSettingsDialog ()

Public Attributes

$id

$name

$shortname

$modulShortCut

$semester

$keywords

$opendate

$closedate

$regpass

$maxstudents

$usewaitinglist

$closed

$info

$faq_url

$style

$errors

Member Function Documentation

SettingsEcom::addError ( $ errorString )

Fuegt Fehlerstring hinzu.

private

Parameters:

string

$errorString - Fehlerstring

Returns:: void

SettingsEcom::echoSettingsDialog ( ) [static]

Gibt einen Dialog fuer die Veranstaltungseinstellungen aus. Verwendet hierzu die Klasse 'SettingsDialog'.

protected

Parameters:

void

Returns:: void

SettingsEcom::formatInfo ( $ info ) [static]

Formatiert eine aus einem Formular uebernommene Veranst.-Information.

private

Parameters:

string

$info - Veranstaltungsinformation, die formatiert werden soll. Die Information muss zuvor mit der Methode CourseSettings::checkCourseInfo($info) erfolgreich ueberprueft worden sein.

Returns:: string $info - formatierte Veranstaltungsinformation.

SettingsEcom::formatName ( $ name ) [static]

Formatiert einen aus einem Formular uebernommenen Veranst.-Namen.

private

Parameters:

string

$coursename - Veranstaltungsname, der formatiert werden soll. Der Name muss zuvor mit der Methode CourseSettings::checkCoursename($coursename) erfolgreich ueberprueft worden sein.

Returns:: string $coursename - formatierter Veranstaltungsname.

SettingsEcom::getClosed ( )

Gibt zurueck, ob der Kurs geschlossen ist.

public

Returns:: integer - 1, falls geschlossen 0, falls nicht

SettingsEcom::getClosedate ( )

Gibt das Enddatum fuer das Anmeldeverfahren zurueck.

public

Returns:: string - Enddatum

SettingsEcom::getDBSettings ( )

Gibt Daten aus Datenbank.courses zurueck.

private

Returns:: string[] - 'Name' - Name der Veranstaltung 'ShortName' - Kurzname der Veranstaltung 'Semester' - Semester i.d. Veranstaltung stattfindet ("03WS") 'OpenDate' - Starttag des Anmeldeverfahrens 'CloseDate' - Endtag des Anmeldeverfahrens 'RegPass' - Passwort zur Anmeldung 'MaxStudents' - Maximale Teilnehmerzahl 'UseWaitinglist' - soll Warteliste benutzt werden 'Info' - allgemein zugaengliche Information

SettingsEcom::getFAQ ( )

Gibt die faq-url zurück

public

Returns:: string - FAQ-URL

SettingsEcom::getID ( )

Gibt die ID der Veranstaltung zurueck.

public

Returns:: integer - ID der Veranstaltung

SettingsEcom::getInfo ( )

Gibt die allgemein zugaengliche Information zurueck.

public

Returns:: string - Infostring

SettingsEcom::getKeywords ( )

Gibt die Stichwörter der Veranstaltung zurück.

public

Returns:: string - Stichwörter der Veranstaltung

SettingsEcom::getMaxStudents ( )

Gibt die Anzahl der maximal teilnehmenden Studenten zurueck.

public

Returns:: integer - maximale Anzahl der Studenten

SettingsEcom::getModulShortCut ( )

Gibt das Modulkürzel der Veranstaltung zurueck.

public

Returns:: string - Modulkürzel der Veranstaltung

SettingsEcom::getName ( )

Gibt den Namen der Veranstaltung zurueck.

public

Returns:: string - Name der Veranstaltung

SettingsEcom::getOpendate ( )

Gibt das Startdatum fuer das Anmeldeverfahren zurueck.

public

Returns:: string - Startdatum

SettingsEcom::getRegpass ( )

Gibt das Passwort fuer das Anmeldeverfahren zurueck.

public

Returns:: string - Passwort

SettingsEcom::getSemester ( )

Gibt das Semester der Veranstaltung zurueck.

public

Returns:: string - Semester, in dem die Veranstaltung stattfindet ( In der Form "04SS" bzw. "03WS" )

SettingsEcom::getShortname ( )

Gibt den Kurznamen der Veranstaltung zurueck.

public

Returns:: string - Kurzname der Veranstaltung

SettingsEcom::getStyle ( )

Gibt den Namen des kursspezifischen Style zurück.

public

Returns:: string Name des kursspezifischen Style

SettingsEcom::getUseWaitinglist ( )

Gibt zurueck, ob eine Warteliste beim Anmeldeverfahren benutzt wird.

public

Returns:: integer - 1, falls Warteliste benutzt wird 0, falls nicht

SettingsEcom::registrationIsActive ( )

Prueft, ob Anmeldeverfahren geoeffnet.

public

Returns:: bool - true, falls Anmeldung moeglich false, falls Anmeldeverfahren vorbei oder noch nicht begonnen

SettingsEcom::resetErrors ( )

Loescht alle Fehlerstrings im Objekt.

public

Returns:: void

SettingsEcom::setClosedate ( $ closedate )

Setzt das Enddatum fuer das Anmeldeverfahren.

public

Parameters:

string

$closedate - Enddatum

Returns:: bool - true, wenn Enddatum gesetzt false, falls Enddatum nicht gestzt werden konnte

SettingsEcom::setFAQURL ( $ faq )

SettingsEcom::setInfo ( $ info )

Setzt die allgemein zugaengliche Information fuer die Veranstaltung.

public

Parameters:

string

$info - Infostring

Returns:: bool - true, wenn Info gesetzt false, falls Info nicht gestzt werden konnte

SettingsEcom::setKeywords ( $ keywords )

Setzt die Stichwörter für die Veranstaltung.

public

Parameters:

string

$keywords - Stichwörter der Veranstaltung

Returns:: bool - true, wenn Stichwörter gesetzt false, falls Stichwörter nicht gestzt werden konnten

SettingsEcom::setMaxStudents ( $ count )

Setzt die maximale Anzahl der an der Veranstaltung teilnehmenden Studenten.

public

Parameters:

integer

$count - Anzahl

Returns:: bool - true, wenn Anzahl gesetzt false, falls Anzahl nicht gestzt werden konnte

SettingsEcom::setModulShortCut ( $ modulShortCut )

Setzt das Modulkürzel.

public

Parameters:

string

$modulShortCut - Kurzame der Veranstaltung

Returns:: bool - true, wenn Modulkürzel gesetzt false, falls Modulkürzel nicht gestzt werden konnte

SettingsEcom::setName ( $ name )

Setzt den Veranstaltungsnamen.

public

Parameters:

string

$name - Name der Veranstaltung

Returns:: bool - true, wenn Name gesetzt false, falls Name nicht gestzt werden konnte

SettingsEcom::setOpendate ( $ opendate )

Setzt das Startdatum fuer das Anmeldeverfahren.

public

Parameters:

string

$opendate - Startdatum

Returns:: bool - true, wenn Startdatum gesetzt false, falls Startdatum nicht gestzt werden konnte

SettingsEcom::setRegpass ( $ regpass )

Setzt das Passwort fuer das Anmeldeverfahren.

public

Parameters:

string

$regpass - Passwort

Returns:: bool - true, wenn Passwort gesetzt false, falls Passwort nicht gestzt werden konnte

SettingsEcom::setSemester ( $ semester )

Setzt das Semester, in dem die Veranstaltung stattfindet.

public

Parameters:

string

$semester - Semesterstring in der Form "WS 03/04" oder "SS 04"

Returns:: bool - true, wenn Semester gesetzt false, falls Semester nicht gestzt werden konnte

SettingsEcom::setShortname ( $ shortname )

Setzt den Veranstaltungskurznamen.

public

Parameters:

string

$shortname - Kurzame der Veranstaltung

Returns:: bool - true, wenn Kurzname gesetzt false, falls Kurzname nicht gestzt werden konnte

SettingsEcom::setStyle ( $ style )

Setzt den kursspezifischen Style.

public

Parameters:

string

$style - Name des Styles

Returns:: bool - true, wenn Style gesetzt false, falls Style nicht gesetzt werden konnte

SettingsEcom::SettingsEcom ( $ courseid )

Konstruktor.

public

Parameters:

integer

$courseid - ID der Veranstaltung

Returns:: bool - true, wenn Objekt fehlerfrei erzeugt false, wenn Fehler auftraten

SettingsEcom::setUseWaitinglist ( $ use )

Legt fest, ob beim Anmeldeverfahren eine Warteliste benutzt werden soll.

public

Parameters:

integer

$use - 1 fuer ja, 0 fuer nein

Returns:: bool - true, wenn gesetzt false, falls nicht gestzt werden konnte

SettingsEcom::validateInfo ( $ info ) [static]

Ueberprueft eine Veranstaltungsinformation auf gueltige Zeichen. Gueltige Zeichen sind alle alphabetischen Gross-und Kleinbuchstaben und alle Zahlen, Zeilenumbrueche, sowie die folgenden Sonderzeichen : ' ','/','Ä','Ö','Ü','ä','ö','ü','-','+','#','(',')',',','.',':','!',';','[',']','{','}','=','*'.

public

Parameters:

string

$pass - Veranstaltungsinformation, die geprueft werden soll.

Returns:: string "" - falls Information gueltig. $errorMessage - falls ungueltige Zeichen in Information enthalten.

SettingsEcom::validateKeywords ( $ keywords ) [static]

Ueberprueft die Stichwörter auf gueltige Zeichen.

public

Parameters:

string

$keywords - Stichwörter, der geprueft werden soll.

Returns:: string "" - falls Stichwörter gueltig. $errorMessage - falls ungültig.

SettingsEcom::validateMaxStudents ( $ maxStudents )

SettingsEcom::validateName ( $ name ) [static]

Ueberprueft einen Veranstaltungsnamen auf gueltige Zeichen. Gueltige Zeichen sind alle alphabetischen Gross-und Kleinbuchstaben und alle Zahlen, sowie die folgenden Sonderzeichen : ' ', '/', 'Ä', 'Ö', 'Ü', 'ä', 'ö', 'ü', '-', '+', '#', '(', ')'

public

Parameters:

string

$coursename - Veranstaltungsname, der geprueft werden soll.

Returns:: string "" - falls Name gueltig. $errorMessage - falls ungueltige Zeichen in Name enthalten.

SettingsEcom::validateRegistrationPassword ( $ pass ) [static]

Ueberprueft einen Veranstaltungspasswort auf gueltige Zeichen.

public

Parameters:

string

$pass - Veranstaltungspasswort, das geprueft werden soll.

Returns:: string "" - falls Passwort gueltig. $errorMessage - falls ungueltige Zeichen in Passwort enthalten.

SettingsEcom::validateShortname ( $ shortname ) [static]

Ueberprueft einen Kurznamen auf gueltige Zeichen. Gueltige Zeichen sind alle alphabetischen Gross-und Kleinbuchstaben und alle Zahlen, sowie die folgenden Sonderzeichen : ' ', '/', 'Ä', 'Ö', 'Ü', 'ä', 'ö', 'ü', '-', '+', '#', '(', ')'

public

Parameters:

string

$shortname - Kurzname, der geprueft werden soll.

Returns:: string "" - falls Name gueltig. $errorMessage - falls ungueltige Zeichen in Name enthalten.

SettingsEcom::validateStyle ( $ style ) [static]

Ueberprueft einen eStudy Style-Namen.

public

Parameters:

string

$style - Der zu prüfende Style-Name

Returns:: string "" - falls der Name gueltig ist $errorMessage - falls der Name ungueltig ist.

Member Data Documentation

SettingsEcom::$closed

SettingsEcom::$closedate

SettingsEcom::$errors

SettingsEcom::$faq_url

SettingsEcom::$id

SettingsEcom::$info

SettingsEcom::$keywords

SettingsEcom::$maxstudents

SettingsEcom::$modulShortCut

SettingsEcom::$name

SettingsEcom::$opendate

SettingsEcom::$regpass

SettingsEcom::$semester

SettingsEcom::$shortname

SettingsEcom::$style

SettingsEcom::$usewaitinglist

The documentation for this class was generated from the following file:

web/courses/classes/class.SettingsEcom.inc.php


Public Member Functions
	SettingsEcom ($courseid)
	addError ($errorString)
	resetErrors ()
	getDBSettings ()
	setName ($name)
	setShortname ($shortname)
	setModulShortCut ($modulShortCut)
	setStyle ($style)
	setKeywords ($keywords)
	setFAQURL ($faq)
	setSemester ($semester)
	setOpendate ($opendate)
	setClosedate ($closedate)
	setRegpass ($regpass)
	setMaxStudents ($count)
	setUseWaitinglist ($use)
	setInfo ($info)
	getID ()
	getName ()
	getShortname ()
	getModulShortCut ()
	getKeywords ()
	getSemester ()
	getOpendate ()
	getClosedate ()
	getRegpass ()
	getUseWaitinglist ()
	getMaxStudents ()
	getInfo ()
	getClosed ()
	getStyle ()
	getFAQ ()
	registrationIsActive ()
	validateMaxStudents ($maxStudents)
Static Public Member Functions
	validateName ($name)
	validateShortname ($shortname)
	validateKeywords ($keywords)
	formatName ($name)
	validateRegistrationPassword ($pass)
	validateInfo ($info)
	formatInfo ($info)
	validateStyle ($style)
	echoSettingsDialog ()
Public Attributes
	$id
	$name
	$shortname
	$modulShortCut
	$semester
	$keywords
	$opendate
	$closedate
	$regpass
	$maxstudents
	$usewaitinglist
	$closed
	$info
	$faq_url
	$style
	$errors